<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>board_common: xrfclk.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">board_common
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="pages.html"><span>Examples</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xrfclk_8h.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">xrfclk.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga918d6c7ecaab240659423c70b3b02057"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xrfclk.html#ga918d6c7ecaab240659423c70b3b02057">XRFClk_WriteReg</a> (u32 ChipId, u32 Data)</td></tr>
<tr class="memdesc:ga918d6c7ecaab240659423c70b3b02057"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is used to write a register on one of LMX2594 or LMX04828.  <a href="group__xrfclk.html#ga918d6c7ecaab240659423c70b3b02057">More...</a><br/></td></tr>
<tr class="separator:ga918d6c7ecaab240659423c70b3b02057"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad22f0b428656960235f5be3e47e4e26e"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xrfclk.html#gad22f0b428656960235f5be3e47e4e26e">XRFClk_ReadReg</a> (u32 ChipId, u32 *Data)</td></tr>
<tr class="memdesc:gad22f0b428656960235f5be3e47e4e26e"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is used to read a register from one of LMX2594 or LMX04828.  <a href="group__xrfclk.html#gad22f0b428656960235f5be3e47e4e26e">More...</a><br/></td></tr>
<tr class="separator:gad22f0b428656960235f5be3e47e4e26e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5a7296352a6f5ff2b511184ee95f496b"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xrfclk.html#ga5a7296352a6f5ff2b511184ee95f496b">XRFClk_Init</a> (int GpioId)</td></tr>
<tr class="memdesc:ga5a7296352a6f5ff2b511184ee95f496b"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is used to initialize RFCLK devices on i2c1-bus: i2c1 bus switch, i2c2spi bridge and MUX_SELx GPIOs.  <a href="group__xrfclk.html#ga5a7296352a6f5ff2b511184ee95f496b">More...</a><br/></td></tr>
<tr class="separator:ga5a7296352a6f5ff2b511184ee95f496b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga15b874b3001ca5c28a1d53ec32b62ef4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xrfclk.html#ga15b874b3001ca5c28a1d53ec32b62ef4">XRFClk_Close</a> ()</td></tr>
<tr class="memdesc:ga15b874b3001ca5c28a1d53ec32b62ef4"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is used to close RFCLK devices.  <a href="group__xrfclk.html#ga15b874b3001ca5c28a1d53ec32b62ef4">More...</a><br/></td></tr>
<tr class="separator:ga15b874b3001ca5c28a1d53ec32b62ef4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae0b716c787b95513649b2fcba33b3b95"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xrfclk.html#gae0b716c787b95513649b2fcba33b3b95">XRFClk_ResetChip</a> (u32 ChipId)</td></tr>
<tr class="memdesc:gae0b716c787b95513649b2fcba33b3b95"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is used to reset one of LMX2594 or LMK04828.  <a href="group__xrfclk.html#gae0b716c787b95513649b2fcba33b3b95">More...</a><br/></td></tr>
<tr class="separator:gae0b716c787b95513649b2fcba33b3b95"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga64c1af6644e83e169033afab6abcf344"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xrfclk.html#ga64c1af6644e83e169033afab6abcf344">XRFClk_SetConfigOnOneChipFromConfigId</a> (u32 ChipId, u32 ConfigId)</td></tr>
<tr class="memdesc:ga64c1af6644e83e169033afab6abcf344"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is used to set a full configuration on one of LMX2594 or LMX04828 for the requested frequency.where the register settings is provided from the selected hard coded data.  <a href="group__xrfclk.html#ga64c1af6644e83e169033afab6abcf344">More...</a><br/></td></tr>
<tr class="separator:ga64c1af6644e83e169033afab6abcf344"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf97229ea09f7cf0d46fb4c1ee6f2f700"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xrfclk.html#gaf97229ea09f7cf0d46fb4c1ee6f2f700">XRFClk_SetConfigOnOneChip</a> (u32 ChipId, u32 *cfgData, u32 len)</td></tr>
<tr class="memdesc:gaf97229ea09f7cf0d46fb4c1ee6f2f700"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is used to set the full configuration data on one of LMX2594 or LMX04828.  <a href="group__xrfclk.html#gaf97229ea09f7cf0d46fb4c1ee6f2f700">More...</a><br/></td></tr>
<tr class="separator:gaf97229ea09f7cf0d46fb4c1ee6f2f700"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga330f1f2804693e7a787ace303ba9a584"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xrfclk.html#ga330f1f2804693e7a787ace303ba9a584">XRFClk_GetConfigFromOneChip</a> (u32 ChipId, u32 *cfgData)</td></tr>
<tr class="memdesc:ga330f1f2804693e7a787ace303ba9a584"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is used to read the full configuration data from one of LMX2594 or LMX04828.  <a href="group__xrfclk.html#ga330f1f2804693e7a787ace303ba9a584">More...</a><br/></td></tr>
<tr class="separator:ga330f1f2804693e7a787ace303ba9a584"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga70661f1623b48f8230135120ab764eca"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xrfclk.html#ga70661f1623b48f8230135120ab764eca">XRFClk_SetConfigOnAllChipsFromConfigId</a> (u32 ConfigId_LMK, u32 ConfigId_RF1, u32 ConfigId_RF2)</td></tr>
<tr class="memdesc:ga70661f1623b48f8230135120ab764eca"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is used to set a full configuration on all LMX2594 and LMK04828 or LMK04208 for the requested frequency.  <a href="group__xrfclk.html#ga70661f1623b48f8230135120ab764eca">More...</a><br/></td></tr>
<tr class="separator:ga70661f1623b48f8230135120ab764eca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa084685a70d719dd933f735cb350fb95"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xrfclk.html#gaa084685a70d719dd933f735cb350fb95">XRFClk_ControlOutputPortLMK</a> (u32 PortId, u32 state)</td></tr>
<tr class="memdesc:gaa084685a70d719dd933f735cb350fb95"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is used to enable or disable the specified output port on LMK04828.  <a href="group__xrfclk.html#gaa084685a70d719dd933f735cb350fb95">More...</a><br/></td></tr>
<tr class="separator:gaa084685a70d719dd933f735cb350fb95"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga91a0033a744f217741b6bf0125914407"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xrfclk.html#ga91a0033a744f217741b6bf0125914407">XRFClk_ConfigOutputDividerAndMUXOnLMK</a> (u32 PortId, u32 DCLKoutX_DIV, u32 DCLKoutX_MUX, u32 SDCLKoutY_MUX, u32 SYSREF_DIV)</td></tr>
<tr class="memdesc:ga91a0033a744f217741b6bf0125914407"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is used to configure a clock divider and the output port MUX state on LMK04828.  <a href="group__xrfclk.html#ga91a0033a744f217741b6bf0125914407">More...</a><br/></td></tr>
<tr class="separator:ga91a0033a744f217741b6bf0125914407"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
